home *** CD-ROM | disk | FTP | other *** search
/ PCGUIA 2010 Software/Programs / PCGuia_programas.iso / Software / Utils / VLC Media Player / vlc-1.0.3-win32.exe / sdk / include / vlc / plugins / vlc_block.h < prev    next >
Encoding:
C/C++ Source or Header  |  2009-10-30  |  11.0 KB  |  312 lines
  1. /*****************************************************************************
  2.  * vlc_block.h: Data blocks management functions
  3.  *****************************************************************************
  4.  * Copyright (C) 2003 the VideoLAN team
  5.  * $Id$
  6.  *
  7.  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
  8.  *
  9.  * This program is free software; you can redistribute it and/or modify
  10.  * it under the terms of the GNU General Public License as published by
  11.  * the Free Software Foundation; either version 2 of the License, or
  12.  * (at your option) any later version.
  13.  *
  14.  * This program is distributed in the hope that it will be useful,
  15.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17.  * GNU General Public License for more details.
  18.  *
  19.  * You should have received a copy of the GNU General Public License
  20.  * along with this program; if not, write to the Free Software
  21.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22.  *****************************************************************************/
  23.  
  24. #ifndef VLC_BLOCK_H
  25. #define VLC_BLOCK_H 1
  26.  
  27. /**
  28.  * \file
  29.  * This file implements functions and structures to handle blocks of data in vlc
  30.  *
  31.  */
  32.  
  33. /****************************************************************************
  34.  * block:
  35.  ****************************************************************************
  36.  * - block_sys_t is opaque and thus block_t->p_sys is PRIVATE
  37.  * - i_flags may not always be set (ie could be 0, even for a key frame
  38.  *      it depends where you receive the buffer (before/after a packetizer
  39.  *      and the demux/packetizer implementations.
  40.  * - i_dts/i_pts could be VLC_TS_INVALID, it means no pts/dts
  41.  * - i_length: length in microseond of the packet, can be null except in the
  42.  *      sout where it is mandatory.
  43.  * - i_rate 0 or a valid input rate, look at vlc_input.h
  44.  *
  45.  * - i_buffer number of valid data pointed by p_buffer
  46.  *      you can freely decrease it but never increase it yourself
  47.  *      (use block_Realloc)
  48.  * - p_buffer: pointer over datas. You should never overwrite it, you can
  49.  *   only incremment it to skip datas, in others cases use block_Realloc
  50.  *   (don't duplicate yourself in a bigger buffer, block_Realloc is
  51.  *   optimised for prehader/postdatas increase)
  52.  ****************************************************************************/
  53. typedef struct block_sys_t block_sys_t;
  54.  
  55. /** The content doesn't follow the last block, or is probably broken */
  56. #define BLOCK_FLAG_DISCONTINUITY 0x0001
  57. /** Intra frame */
  58. #define BLOCK_FLAG_TYPE_I        0x0002
  59. /** Inter frame with backward reference only */
  60. #define BLOCK_FLAG_TYPE_P        0x0004
  61. /** Inter frame with backward and forward reference */
  62. #define BLOCK_FLAG_TYPE_B        0x0008
  63. /** For inter frame when you don't know the real type */
  64. #define BLOCK_FLAG_TYPE_PB       0x0010
  65. /** Warn that this block is a header one */
  66. #define BLOCK_FLAG_HEADER        0x0020
  67. /** This is the last block of the frame */
  68. #define BLOCK_FLAG_END_OF_FRAME  0x0040
  69. /** This is not a key frame for bitrate shaping */
  70. #define BLOCK_FLAG_NO_KEYFRAME   0x0080
  71. /** This block contains the last part of a sequence  */
  72. #define BLOCK_FLAG_END_OF_SEQUENCE 0x0100
  73. /** This block contains a clock reference */
  74. #define BLOCK_FLAG_CLOCK         0x0200
  75. /** This block is scrambled */
  76. #define BLOCK_FLAG_SCRAMBLED     0x0400
  77. /** This block has to be decoded but not be displayed */
  78. #define BLOCK_FLAG_PREROLL       0x0800
  79. /** This block is corrupted and/or there is data loss  */
  80. #define BLOCK_FLAG_CORRUPTED     0x1000
  81.  
  82. #define BLOCK_FLAG_TYPE_MASK \
  83.     (BLOCK_FLAG_TYPE_I|BLOCK_FLAG_TYPE_P|BLOCK_FLAG_TYPE_B|BLOCK_FLAG_TYPE_PB)
  84.  
  85. /* These are for input core private usage only */
  86. #define BLOCK_FLAG_CORE_PRIVATE_MASK  0x00ff0000
  87. #define BLOCK_FLAG_CORE_PRIVATE_SHIFT 16
  88.  
  89. /* These are for module private usage only */
  90. #define BLOCK_FLAG_PRIVATE_MASK  0xff000000
  91. #define BLOCK_FLAG_PRIVATE_SHIFT 24
  92.  
  93. typedef void (*block_free_t) (block_t *);
  94.  
  95. struct block_t
  96. {
  97.     block_t     *p_next;
  98.  
  99.     uint32_t    i_flags;
  100.  
  101.     mtime_t     i_pts;
  102.     mtime_t     i_dts;
  103.     mtime_t     i_length;
  104.  
  105.     int         i_samples; /* Used for audio */
  106.     int         i_rate;
  107.  
  108.     size_t      i_buffer;
  109.     uint8_t     *p_buffer;
  110.  
  111.     /* Rudimentary support for overloading block (de)allocation. */
  112.     block_free_t pf_release;
  113. };
  114.  
  115. /****************************************************************************
  116.  * Blocks functions:
  117.  ****************************************************************************
  118.  * - block_Alloc : create a new block with the requested size ( >= 0 ), return
  119.  *      NULL for failure.
  120.  * - block_Release : release a block allocated with block_Alloc.
  121.  * - block_Realloc : realloc a block,
  122.  *      i_pre: how many bytes to insert before body if > 0, else how many
  123.  *      bytes of body to skip (the latter can be done without using
  124.  *      block_Realloc i_buffer -= -i_pre, p_buffer += -i_pre as i_pre < 0)
  125.  *      i_body (>= 0): the final size of the body (decreasing it can directly
  126.  *      be done with i_buffer = i_body).
  127.  *      with preheader and or body (increase
  128.  *      and decrease are supported). Use it as it is optimised.
  129.  * - block_Duplicate : create a copy of a block.
  130.  ****************************************************************************/
  131. VLC_EXPORT( void,      block_Init,    ( block_t *, void *, size_t ) );
  132. VLC_EXPORT( block_t *, block_Alloc,   ( size_t ) LIBVLC_USED );
  133. VLC_EXPORT( block_t *, block_Realloc, ( block_t *, ssize_t i_pre, size_t i_body ) LIBVLC_USED );
  134.  
  135. #define block_New( dummy, size ) block_Alloc(size)
  136.  
  137. LIBVLC_USED
  138. static inline block_t *block_Duplicate( block_t *p_block )
  139. {
  140.     block_t *p_dup = block_Alloc( p_block->i_buffer );
  141.     if( p_dup == NULL )
  142.         return NULL;
  143.  
  144.     p_dup->i_dts     = p_block->i_dts;
  145.     p_dup->i_pts     = p_block->i_pts;
  146.     p_dup->i_flags   = p_block->i_flags;
  147.     p_dup->i_length  = p_block->i_length;
  148.     p_dup->i_rate    = p_block->i_rate;
  149.     p_dup->i_samples = p_block->i_samples;
  150.     memcpy( p_dup->p_buffer, p_block->p_buffer, p_block->i_buffer );
  151.  
  152.     return p_dup;
  153. }
  154.  
  155. static inline void block_Release( block_t *p_block )
  156. {
  157.     p_block->pf_release( p_block );
  158. }
  159.  
  160. VLC_EXPORT( block_t *, block_mmap_Alloc, (void *addr, size_t length) LIBVLC_USED );
  161. VLC_EXPORT( block_t *, block_File, (int fd) LIBVLC_USED );
  162.  
  163. static inline void block_Cleanup (void *block)
  164. {
  165.     block_Release ((block_t *)block);
  166. }
  167. #define block_cleanup_push( block ) vlc_cleanup_push (block_Cleanup, block)
  168.  
  169. /****************************************************************************
  170.  * Chains of blocks functions helper
  171.  ****************************************************************************
  172.  * - block_ChainAppend : append a block to the last block of a chain. Try to
  173.  *      avoid using with a lot of data as it's really slow, prefer
  174.  *      block_ChainLastAppend
  175.  * - block_ChainLastAppend : use a pointer over a pointer to the next blocks,
  176.  *      and update it.
  177.  * - block_ChainRelease : release a chain of block
  178.  * - block_ChainExtract : extract data from a chain, return real bytes counts
  179.  * - block_ChainGather : gather a chain, free it and return one block.
  180.  ****************************************************************************/
  181. static inline void block_ChainAppend( block_t **pp_list, block_t *p_block )
  182. {
  183.     if( *pp_list == NULL )
  184.     {
  185.         *pp_list = p_block;
  186.     }
  187.     else
  188.     {
  189.         block_t *p = *pp_list;
  190.  
  191.         while( p->p_next ) p = p->p_next;
  192.         p->p_next = p_block;
  193.     }
  194. }
  195.  
  196. static inline void block_ChainLastAppend( block_t ***ppp_last, block_t *p_block )
  197. {
  198.     block_t *p_last = p_block;
  199.  
  200.     **ppp_last = p_block;
  201.  
  202.     while( p_last->p_next ) p_last = p_last->p_next;
  203.     *ppp_last = &p_last->p_next;
  204. }
  205.  
  206. static inline void block_ChainRelease( block_t *p_block )
  207. {
  208.     while( p_block )
  209.     {
  210.         block_t *p_next = p_block->p_next;
  211.         block_Release( p_block );
  212.         p_block = p_next;
  213.     }
  214. }
  215.  
  216. static size_t block_ChainExtract( block_t *p_list, void *p_data, size_t i_max )
  217. {
  218.     size_t  i_total = 0;
  219.     uint8_t *p = (uint8_t*)p_data;
  220.  
  221.     while( p_list && i_max )
  222.     {
  223.         size_t i_copy = __MIN( i_max, p_list->i_buffer );
  224.         memcpy( p, p_list->p_buffer, i_copy );
  225.         i_max   -= i_copy;
  226.         i_total += i_copy;
  227.         p       += i_copy;
  228.  
  229.         p_list = p_list->p_next;
  230.     }
  231.     return i_total;
  232. }
  233.  
  234. static inline void block_ChainProperties( block_t *p_list, int *pi_count, size_t *pi_size, mtime_t *pi_length )
  235. {
  236.     size_t i_size = 0;
  237.     mtime_t i_length = 0;
  238.     int i_count = 0;
  239.  
  240.     while( p_list )
  241.     {
  242.         i_size += p_list->i_buffer;
  243.         i_length += p_list->i_length;
  244.         i_count++;
  245.  
  246.         p_list = p_list->p_next;
  247.     }
  248.  
  249.     if( pi_size )
  250.         *pi_size = i_size;
  251.     if( pi_length )
  252.         *pi_length = i_length;
  253.     if( pi_count )
  254.         *pi_count = i_count;
  255. }
  256.  
  257. static inline block_t *block_ChainGather( block_t *p_list )
  258. {
  259.     size_t  i_total = 0;
  260.     mtime_t i_length = 0;
  261.     block_t *g;
  262.  
  263.     if( p_list->p_next == NULL )
  264.         return p_list;  /* Already gathered */
  265.  
  266.     block_ChainProperties( p_list, NULL, &i_total, &i_length );
  267.  
  268.     g = block_Alloc( i_total );
  269.     block_ChainExtract( p_list, g->p_buffer, g->i_buffer );
  270.  
  271.     g->i_flags = p_list->i_flags;
  272.     g->i_pts   = p_list->i_pts;
  273.     g->i_dts   = p_list->i_dts;
  274.     g->i_length = i_length;
  275.  
  276.     /* free p_list */
  277.     block_ChainRelease( p_list );
  278.     return g;
  279. }
  280.  
  281. /****************************************************************************
  282.  * Fifos of blocks.
  283.  ****************************************************************************
  284.  * - block_FifoNew : create and init a new fifo
  285.  * - block_FifoRelease : destroy a fifo and free all blocks in it.
  286.  * - block_FifoEmpty : free all blocks in a fifo
  287.  * - block_FifoPut : put a block
  288.  * - block_FifoGet : get a packet from the fifo (and wait if it is empty)
  289.  * - block_FifoShow : show the first packet of the fifo (and wait if
  290.  *      needed), be carefull, you can use it ONLY if you are sure to be the
  291.  *      only one getting data from the fifo.
  292.  * - block_FifoCount : how many packets are waiting in the fifo
  293.  * - block_FifoWake : wake ups a thread with block_FifoGet() = NULL
  294.  *   (this is used to wakeup a thread when there is no data to queue)
  295.  *
  296.  * block_FifoGet and block_FifoShow are cancellation points.
  297.  ****************************************************************************/
  298.  
  299. VLC_EXPORT( block_fifo_t *, block_FifoNew,      ( void ) LIBVLC_USED );
  300. VLC_EXPORT( void,           block_FifoRelease,  ( block_fifo_t * ) );
  301. /* TODO: do we need to export this? */
  302. void block_FifoPace (block_fifo_t *fifo, size_t max_depth, size_t max_size);
  303. VLC_EXPORT( void,           block_FifoEmpty,    ( block_fifo_t * ) );
  304. VLC_EXPORT( size_t,         block_FifoPut,      ( block_fifo_t *, block_t * ) );
  305. VLC_EXPORT( void,           block_FifoWake,     ( block_fifo_t * ) );
  306. VLC_EXPORT( block_t *,      block_FifoGet,      ( block_fifo_t * ) LIBVLC_USED );
  307. VLC_EXPORT( block_t *,      block_FifoShow,     ( block_fifo_t * ) );
  308. size_t block_FifoSize( const block_fifo_t *p_fifo ) LIBVLC_USED;
  309. VLC_EXPORT( size_t,         block_FifoCount,    ( const block_fifo_t *p_fifo ) LIBVLC_USED );
  310.  
  311. #endif /* VLC_BLOCK_H */
  312.